home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 April: Mac OS SDK / Dev.CD Apr 98 SDK1.toast / Development Kits (Disc 1) / AppleSearch / Macintosh / AppleSearch Client API / Headers / ASClientErrors.h < prev   
Encoding:
C/C++ Source or Header  |  1995-01-19  |  6.9 KB  |  143 lines  |  [TEXT/MPS ]
  1. /*===============================================================================================================
  2.  
  3.             ASClientErrors.h
  4.         
  5.             Copyright Apple Computer, Inc. 1992-1994
  6.             All rights reserved
  7.  
  8. ===============================================================================================================*/
  9.  
  10. #ifndef __ASCLIENTERRORS__
  11. #define __ASCLIENTERRORS__
  12.  
  13. //______________________________________________________________________________________________________________________
  14. //______________________________________________________ INCLUDES ______________________________________________________
  15. //______________________________________________________________________________________________________________________
  16.  
  17. #ifndef __ASCLIENTAPI__
  18. #include "ASClientAPI.h"
  19. #endif
  20.  
  21. //______________________________________________________________________________________________________________________
  22. //______________________________________________________ CONSTANTS _____________________________________________________
  23. //______________________________________________________________________________________________________________________
  24. // constants for param block range checking
  25.  
  26. // Search 
  27. #define    kMinQuerySize         1
  28. #define    kMaxQuerySize         1000
  29. #define    kMinRankAllowed         1
  30. #define    kMaxRankAllowed         5
  31. #define    kMinHitsAllowed         1
  32. #define    kMaxHitsAllowed         30000
  33.  
  34. // Reporter
  35. #define    kMaxReporterName         20
  36. #define    kMinReporterQuerySize    0
  37. #define    kMinReporterSources         0
  38. #define    kMinReporterFlags         0
  39. #define    kMaxReporterFlags         1
  40. #define    kMaxDeliveryDays         0x7F        // all seven days of the week
  41. #define    kMaxDeliveryTime         86399    // 11:59:59PM
  42.  
  43. // GetText/Original
  44. #define    kMinTextSize            1
  45. #define    kMaxTextSize            32000
  46. #define    kMaxGetOriginalFileFlag    2
  47.  
  48. // GetRelatedTerms
  49. #define    kMinTermsAllowed        1
  50. #define    kMaxTermsAllowed        100
  51.  
  52. //______________________________________________________________________________________________________________________
  53. // error codes generated by client
  54.  
  55. // OS level error
  56. #define    kUnknownErr                        3000
  57. #define    kOutOfMemoryErr                    3001
  58. #define    kOutOfMemoryNoObjectErr            3002
  59. #define    kOutOfMemoryNoPBErr                3003
  60.  
  61. // house-keeping function errors
  62. #define    kMaxRegisteredErr                3101
  63. #define    kInvalidRegistrationIDErr        3102
  64. #define    kAlreadyLoggedOnErr                3103
  65. #define    kLogOnCancelErr                    3104
  66. #define    kStillLoggedOnErr                3105
  67. #define    kNotLoggedOnErr                    3106
  68. #define    kNoIdentificationErr            3108
  69. #define    kNoCompletionProcErr            3109
  70. #define    kAlreadyLoggingOnErr            3112
  71.  
  72. #define    kAuthExtensionNotFoundErr        3201
  73. #define    kAuthExtensionOutOfMemoryErr    3202
  74.  
  75. #define    kInvalidDeliveryDaysErr            3407
  76. #define    kInvalidDeliveryTimeErr            3408
  77.  
  78. // search errors
  79. #define    kQueryLengthRangeErr        1017                                // (kNoQueryString); used to be 3301
  80. #define    kQueryEmptyStringErr        1017                                    // (kNoQueryString); used to be 3302
  81. #define    kQueryMissingStringErr        1017                                    // (kNoQueryString); used to be 3303
  82. #define    kQueryStringMissingErr        1017                                    // (kNoQueryString); used to be 3304
  83. #define    kMaxHitsRangeErr            1020                                    // (kInvalidMaxHits); used to be 3306
  84.  
  85. // reporter errors
  86. #define    kReporterNameEmptyErr        1025                                    // (kInvalidObjectName); used to be 3402
  87. #define    kReporterNameLengthErr        1025                                    // (kInvalidObjectName); used to be 3403
  88. #define    kReporterNameMissingErr        1025                                    // (kInvalidObjectName); used to be 3404
  89. #define    kDeliveryDirLengthErr        1026                                    // (kInvalidObjectData); used to be 3405
  90. #define    kDeliveryDirMissingErr        1026                                    // (kInvalidObjectData); used to be 3406
  91. #define    kReporterSourceCountErr        3409
  92. #define    kMissingSourceErr            1006                                    // (kInvalidSourceID); used to be 3410
  93.  
  94. // dbObject errors
  95. #define    kDBObjectNameLengthErr        1025                                    // (kInvalidObjectName); used to be 3502
  96. #define    kDBObjectNameMissingErr        1025                                    // (kInvalidObjectName); used to be 3503
  97. #define    kDBObjectDataLengthErr        1026                                    // (kInvalidObjectData); used to be 3504
  98. #define    kDBObjectDataMissingErr        1026                                    // (kInvalidObjectData); used to be 3505
  99.  
  100. // session errors
  101. #define    kReplyMatchesNoRequestErr    3601
  102. #define    kInvalidReplyDataErr        3602
  103. #define    kInvalidRequestDataErr        3603
  104.  
  105. //______________________________________________________________________________________________________________________
  106. // errors returned by the server
  107.  
  108. #define kInvalidRequestForGuestErr     1001    // when guests try to make database requests
  109. #define kInvalidSessionIDErr        1002    // when client sends a non-existing session ID
  110. #define kRequestIDNotFoundErr        1003    // when client tries to cancel an invalid request
  111. #define kSessionIDNotFoundErr        1004    // when client tries to log off with invalid session ID
  112. #define kTransactionFailedErr        1005    // requested pls transaction failed
  113. #define kInvalidSourceIDErr            1006    // when client sends a non-existing info source ID
  114. #define kInvalidDocIDErr            1007    // when client sends a non-existing document ID
  115. #define kNoAccessPriviligesErr        1008    // when client tries to access a file for which he doesn't have access
  116. #define kServerGoingDownErr            1009    // when the server is in the process of shutting down
  117. #define kInvalidObjectIDErr            1010    // object id for ObjectRequest is bad
  118. #define kNoSharingOnServerErr        1011    // server doesn't have File Sharing or AppleShare running
  119. #define kWrongProtocolErr            1012    // client is using the wrong protocol version
  120. #define kFileNotFoundErr            1013    // GetFile wasn't able to locate the file
  121. #define kDuplicateNameErr            1014    // Tried to add reporter with name that exists
  122. #define kTooManyUsersErr            1015    // Max # of users already logged in
  123. #define kInfoSourceHiddenErr        1016 // Info source on which you tried to execute this request is Hidden.
  124. #define kNoQueryStringErr            1017 // when client sends a zero-lebgth query string
  125. #define kQueryStringTooLongErr        1018 // when client sends a very long query string
  126. #define kInvalidMinRankErr            1019 // min rank requested not in the range (1..5)
  127. #define kInvalidMaxHitsErr            1020 // Max hits requested <= 0 on search request
  128. #define kInvalidMaxTermsErr            1021 // Max terms requested <= 0 on related terms request
  129. #define kInvalidTextBoundsErr        1022 // The startByte/endByte combo doesn't make sense
  130. #define kInvalidOperationErr        1023 // Invalid operation in DBObject/DBDBReporter request
  131. #define kInvalidObjectTypeErr        1024    // invalid objectType in DBObject/DBEnumerate req
  132. #define kInvalidObjectNameErr        1025    // bogus objectName
  133. #define kInvalidObjectDataErr        1026    // objectDataSize is bogus
  134. #define kInvalidFlagsErr            1027    // Flags field is invalid (DBReporter/GetFile)
  135. #define kInvalidSubSessionIDErr        1028    // invalid subSessionID
  136. #define kDuplicateTickleErr            1029 // duplicate Tickle request
  137. #define kParamErr                    1030 // received a mal-formed request (too short, or too long)
  138. #define kInternalErr                1031 // Bad things happened on the server.  May be it's time to restart.
  139. #define kQuerySyntaxErr                1032    // Syntax error in query
  140. #define kFileModSinceIndexErr        1033    // The file has been modified since indexing, so you can't do GetText on it.
  141.                                             
  142. #endif                                                                        // __ASCLIENTERRORS__
  143.